spiisolator9 2.2.2
Loading...
Searching...
No Matches
SPI Isolator 9 Click Driver

API for configuring and manipulating SPI Isolator 9 Click driver. More...

Topics

 SPI Isolator 9 Registers Settings
 Settings for registers of SPI Isolator 9 Click driver.
 SPI Isolator 9 MikroBUS Map
 MikroBUS pin mapping of SPI Isolator 9 Click driver.

Functions

void spiisolator9_cfg_setup (spiisolator9_cfg_t *cfg)
 SPI Isolator 9 configuration object setup function.
err_t spiisolator9_init (spiisolator9_t *ctx, spiisolator9_cfg_t *cfg)
 SPI Isolator 9 initialization function.
err_t spiisolator9_write (spiisolator9_t *ctx, uint8_t *data_in, uint8_t len)
 SPI Isolator 9 write function.
err_t spiisolator9_read (spiisolator9_t *ctx, uint8_t *data_out, uint8_t len)
 SPI Isolator 9 read function.
err_t spiisolator9_write_then_read (spiisolator9_t *ctx, uint8_t *data_in, uint8_t in_len, uint8_t *data_out, uint8_t out_len)
 SPI Isolator 9 write then read function.

Detailed Description

API for configuring and manipulating SPI Isolator 9 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ spiisolator9_cfg_setup()

void spiisolator9_cfg_setup ( spiisolator9_cfg_t * cfg)

SPI Isolator 9 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See spiisolator9_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ spiisolator9_init()

err_t spiisolator9_init ( spiisolator9_t * ctx,
spiisolator9_cfg_t * cfg )

SPI Isolator 9 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters
[out]ctx: Click context object. See spiisolator9_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See spiisolator9_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ spiisolator9_read()

err_t spiisolator9_read ( spiisolator9_t * ctx,
uint8_t * data_out,
uint8_t len )

SPI Isolator 9 read function.

This function reads a desired number of data bytes by using SPI serial interface.

Parameters
[in]ctx: Click context object. See spiisolator9_t object definition for detailed explanation.
[out]data_out: Output read data.
[in]len: Number of bytes to be read.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ spiisolator9_write()

err_t spiisolator9_write ( spiisolator9_t * ctx,
uint8_t * data_in,
uint8_t len )

SPI Isolator 9 write function.

This function writes a desired number of data bytes by using SPI serial interface.

Parameters
[in]ctx: Click context object. See spiisolator9_t object definition for detailed explanation.
[in]data_in: Data to be written.
[in]len: Number of bytes to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ spiisolator9_write_then_read()

err_t spiisolator9_write_then_read ( spiisolator9_t * ctx,
uint8_t * data_in,
uint8_t in_len,
uint8_t * data_out,
uint8_t out_len )

SPI Isolator 9 write then read function.

This function writes and then reads a desired number of data bytes by using SPI serial interface.

Parameters
[in]ctx: Click context object. See spiisolator9_t object definition for detailed explanation.
[in]data_in: Data to be written.
[in]in_len: Number of bytes to be written.
[out]data_out: Output read data.
[in]out_len: Number of bytes to be read.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.